home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / mnwiz110.zip / MENUWIZ.DOC next >
Text File  |  1988-09-29  |  19KB  |  478 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                    ****    ****  ********  ***     **  **    **
  13.                    ** **  ** **  **        ****    **  **    **
  14.                    **  ****  **  **        ** **   **  **    **
  15.                    **   **   **  ********  **  **  **  **    **
  16.                    **        **  **        **   ** **  **    **
  17.                    **        **  **        **    ****  **    **
  18.                    **        **  **        **     ***  **    **
  19.                    **        **  ********  **      **   ******
  20.  
  21.            **       **  **  **********   *******   ********   *******
  22.            **       **  **          **  **     **  **     **  **    **
  23.            **       **  **        **    **     **  **     **  **    **
  24.            **   *   **  **      **      *********  ********   **    **
  25.            **  ***  **  **    **        **     **  **  **     **    **
  26.            ** ** ** **  **  **          **     **  **   **    **    **
  27.             ***   ***   **  **********  **     **  **    **   *******
  28.  
  29.                            A Deluxe QuickBBS Menu Editor
  30.                               Written by Alon Gingold
  31.  
  32.                       Copyright (c) 1988,1989 by Alon Gingold
  33.  
  34. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  35.  
  36.  
  37.                Menu Wizard v1.00 - User Document - Page 1
  38.  
  39.  
  40.  
  41.  Introduction:
  42.  -------------
  43.  
  44.      Menu Wizard is a delux menu editor written for QuickBBS, which was
  45.      designed to help the average MENUEDIT user getting out of the gray life
  46.      he's having. Menu Wizard uses fancy screen display, dazzling colors, and
  47.      a "BORLNAD(tm)-ALIKE" windows and menus for comfortable editing.
  48.  
  49.      The main idea in Menu Wizard is to devide the menu's text, from the menu
  50.      commands and data, using an internal EDITOR, and a gateway to external
  51.      ANSI and ASCII editors for external texts (command type 40).
  52.  
  53.      "Menu-Wizard-loves-you", the whole program is operating using pull down
  54.      menus, and arrow-keys selections. You even load a menu by choosing it
  55.      with the arrow keys (ofcourse, you may write a filename, if that's what
  56.      you want).
  57.  
  58.      In General, Menu Wizard, is a powerful and easy-to-use software for
  59.      the most hard and painful installation procedure of QuickBBS- the
  60.      menus creation...
  61.  
  62.  
  63.  
  64.  
  65.                Menu Wizard v1.00 - User Document - Page 2
  66.  
  67.  
  68.  
  69.  Thanks where thanks is due.
  70.  ---------------------------
  71.   Ronen Magid,which helped with the basic planning of Menu Wizard,
  72.               advising in upgrading the B/W program to a colored version,
  73.               and forming the basic documentation.
  74.  
  75.   Oren and Dror Tirosh,which answered my over-numbered phone calls,about
  76.               programming technical and general problems.
  77.  
  78.   Moshe boochbut,for helping in the documentation and solving general
  79.               problems.
  80.  
  81.   Gilad Goldfarb for helping in the debuging process,writing the doc,and
  82.                 making it possible for Menu Wizard to reach the USA.
  83.  
  84.   Alon Gingold ,well, just for writting it...
  85.  
  86.  
  87.  
  88.                Menu Wizard v1.00 - User Document - Page 3
  89.  
  90.  
  91.  
  92.  Registration fees and policy.
  93.  -----------------------------
  94.  
  95.      I have spent many hours ,days and months of creating,writting,
  96.      debugging,documenting and improoving Menu Wizard to make the it as
  97.      comfortable,fast,and efficient as possible.
  98.  
  99.      Because of that reason I have decided to make Menu Wizard a
  100.      User-Supported program.
  101.  
  102.      Some of the program's options will not work unless a registration will
  103.      be made.In addition ,a 10 second delay at the beginning of the program's
  104.      execution,will ocurre untill you register your copy.
  105.  
  106.      In order to register your Menu Wizard copy,please fill the registration
  107.      form (which is included in the ARC file of Menu Wizard) with the
  108.      exact details and send it ,and the $15 registration fee ,plus
  109.      $3 re-mail costs ,to the following address:
  110.  
  111.                 Alon Gingold
  112.                 Hitch Hiker's BBS
  113.                 P.O.B 450 Raanana
  114.                 Israel
  115.  
  116.      A registration code will be sent in re-mail and the instruction to install
  117.      it,and make the registration options work.
  118.  
  119.      When you recive the code in re-mail , write it in the file MWCODE.CTL in
  120.      the same directory menu wizard is executed from.This file is an asci file
  121.      which can be created by a simple 'Copy con' command,like this :
  122.  
  123.      c:\qbbs>copy con mwcode.ctl
  124.      1234567890<CR>  <- Your code.
  125.      ^Z<CR><CR>
  126.  
  127.      REMEMBER : The code must be copied exectly to the file,in the first line
  128.                 and coloumn !
  129.  
  130.      New versions will work with the registration codes. New versions of
  131.      Menu Wizard could be Downloaded from the Menu Wizard Support board :
  132.  
  133.      The Wizard's Castle BBS
  134.      2:40/200 24h   (972)-3-503-3166    300/1200/2400
  135.  
  136.      Please send any comments ,suggestions and bug reports to the support board
  137.      or to my address.
  138.  
  139.  
  140.  
  141.                Menu Wizard v1.00 - User Document - Page 4
  142.  
  143.  
  144.  
  145.  Installation:
  146.  -------------
  147.  
  148.      Menu Wizard is a very easy-to-install program, all you have to do is to
  149.      put the .EXE file somewhere and run it. The first time Menu Wizard is
  150.      executed, it will then ask the following Questions:
  151.  
  152.       1) QuickBBS path: Where is the QuickBBS home directory (where it will
  153.                         find all its configuration files)
  154.  
  155.       2) Ascii Editor:  The file name of an ASCII editor in path
  156.                         (e.g. "NE"  "E2"). It would run through the
  157.                         COMMAND.COM and will require the editor to be in the
  158.                         path, or you'll have to enter a full path of it as well
  159.  
  160.       3) Ansi Edior  :  Same as Ascii Editor, it is for ANSI editing
  161.                         (e.g "TheDraw"<tm>)
  162.  
  163.       4) Direct Screen: Menu Wizard needs to know whether to write
  164.                         Directly to screen (FAST) or to use the BIOS built
  165.                         in routines for SCREEN I/O (SLOWER..)
  166.                         NOTE: Menu-Wizard is NOT a remote program and it
  167.                         cannot be operated using CTTY or any gateway program.
  168.  
  169.       5) Use Flags? :   Menu-Wizard has 2 editing modes: With Flags, or
  170.                         without them, if you choose to work with them, flags
  171.                         will be presented at the right side of the screen, and
  172.                         if not , they'll be hidden. Pressing TAB will toggle
  173.                         these modes while editing.
  174.  
  175.  
  176.      Note that these parameters are saved in the current directory you
  177.      executed the Menu-Wizard from,  or it would ask you to set-up itself
  178.      again. We recommend you run it from your QuickBBS directory. Set-Up
  179.      could be changed by choosing the "SETUP" option.the setup file name
  180.      is MENUWIZ.CTL.
  181.  
  182.  
  183.  
  184.  
  185.                Menu Wizard v1.00 - User Document - Page 5
  186.  
  187.  
  188.  
  189.  Working with Menu-Wizard:
  190.  -------------------------
  191.  
  192.  After running Menu-Wizard (and setting it up, if you run it for the first
  193.  time) it will automatically load the "TOP" menu, unless you run it with
  194.  a filename parameter which will cause it to load the menu you choose like
  195.  this:
  196.  
  197.  C:\QBBS\>MenuWiz <menuname> (No .MNU extesion is required)
  198.  
  199.  You will now find yourself in the main menu. This is a typical Pull-Down
  200.  menu where you can play around with the ARROW KEYS and the ENTER key to
  201.  choose a selection.
  202.  
  203.  Your main menu contains 6 options:
  204.  
  205.  
  206.  Files Options:    (Main menu option #1)
  207.  --------------
  208.  
  209.     Load: This will load a menu. A "FILES BOX" will be opened and you will
  210.           be able to choose the filenames with a highlighted cursor and
  211.           choose the desired menu by pressing ENTER. Note you can press
  212.           ALT-<LETTER> to transfer the cursor to the next filename starting
  213.           with that letter. You can also TYPE the filename you wish to load
  214.           by simply typing it.
  215.  
  216.     View: Same As load. But this will ask you to choose an "ANS/ASC" file
  217.           from the TEXT directory and will display it. without erasing anything
  218.           in memory.
  219.  
  220.      New: This option allows the user to start a new menu. If you choose it
  221.           while a menu that was previously loaded and changed reside in
  222.           memory, Manu Wizard will ask you wheather you want to save it.
  223.  
  224.     Save: This will save the menu in the original filename unless you start
  225.           a new menu (NONAME.MNU)
  226.  
  227.  WriteTo: This will save the current menu in memory to a filename you will
  228.           be asked to give.
  229.  
  230.      Dir: This will dislay the current directory.
  231.  
  232.     Copy: Makes a Copy of menus or Text Files.
  233.  
  234.   Rename: Renames a menu or a Text file.
  235.  
  236.    Shell: Shells to DOS and lets you oprerate other applications, typing
  237.           "EXIT" at the DOS prompt will return you to Menu-Wizard
  238.  
  239.     Quit: Quit, Will ask you whether to save the menu or dump it.
  240.  
  241.  
  242.  
  243.                Menu Wizard v1.00 - User Document - Page 6
  244.  
  245.  
  246.  
  247.  Commands:
  248.  ---------
  249.  
  250.     Edit: Enters command edit mode. Each line represents a menu entry, you
  251.           may scroll using ARROWS/PgUp/PgDn/Home & END, for editing a command,
  252.           press ENTER while you place the highlighted bar on it.
  253.           For adding a new entry go to the end of the menu using END and
  254.           press ENTER.
  255.  
  256.           The add/edit procedure will first ask you the command type you wish
  257.           to add/edit. A window will appear with a list of command topics
  258.           availble and a few general commands. you may move using the up and
  259.           down arrows, and choose by pressing ENTER. if you choose a topic
  260.           (such as 'Goto & Gosub' or 'File & dos' ) a sub menu will appear on
  261.           the screen and you may choose an command from there (by pressing
  262.           ENTER again). You can return to the previos menu by pressing ESC.
  263.           If you are editing a command, pressing ENTER twice (when the command
  264.           menu appears) will choose the same command as was before.
  265.  
  266.           After editing the command type you will be editing the DATA field.
  267.           The data field is related to the command type.In most cases,
  268.           Menu Wizard will tell you what kind of information it is expecting
  269.           you to enter,expect while editing the message base related commands.
  270.           Those commands will make Menu Wizard show a message bases window.
  271.           You will be able to move around the message bases,as they appear in
  272.           the qbbs configuration file.In case of editing an existing line,
  273.           the highlighted bar will stand on the current message area.
  274.           Press ENTER to choose.
  275.  
  276.           The third field is the key that should be pressed to activate that
  277.           certain command. Press a key to change the existing one.The keys
  278.           available are any one-code keys from char #1 up to char #126
  279.           The original Menu editor (as written by Adam Hudson) did not allow
  280.           entering Control codes as a command key but QBBS did.You may try
  281.           any key.
  282.           The CTRL-A key is used for automatic execution of the choosen
  283.           command.
  284.  
  285.           After editing the command field, you will edit the flags (only if
  286.           you are using the flag mode).
  287.           Use "-","x" to determine if the flag will be on or off or use
  288.           "SPACEBAR" to toggle between "x" and "-".
  289.  
  290.           Pressing the <Ins> key will insert a new command before the
  291.           highlighted command.
  292.  
  293.           The <Del> key deletes the highlighted line, it will
  294.           ask for your acknowledgment.
  295.  
  296.  
  297.  
  298.  
  299.                Menu Wizard v1.00 - User Document - Page 7
  300.  
  301.  
  302.  
  303.           Special Functions:
  304.           ------------------
  305.  
  306.           F1- While editing, if you're highlighting a "type 1-alike" command
  307.               (goto menu,gosub menu etc.) Pressing <F1> will automatically save
  308.               the current menu, and load the menu that is highlighted. This
  309.               invoks a stack with a "50-menus limit".
  310.             * This option will only work on registerd versions.
  311.  
  312.           F2- This will return to the previous menu you edited and escaped
  313.               from by using F1.
  314.             * This option will only work on registerd versions.
  315.  
  316.           F3- Like F1, but kills the stack.
  317.             * This option will only work on registerd versions.
  318.  
  319.           F4- Create a subdirectory (This will only take place if the select-
  320.               bar highlights a file related command.
  321.  
  322.           F5- Execute your Text Editor. If it is a display file option, Manu
  323.               Wizard will give as parameter the file you specified in the
  324.               data field. If it is a file related command, it will add as a
  325.               parameter the FILES.BBS in the file directory.
  326.  
  327.           F6- Execute your ANSI Editor. NOTE: This option will only work if
  328.               you are higlighting a display ANS/ASC file.
  329.  
  330.          F10- Display a short reference guide.
  331.  
  332.         Char- Like F1,loads the menu that coresponds to the key pressed,only
  333.               if such a command exist and it is a gosub or a goto command.
  334.               This also ,like F1, invoks a stack with a "50-menus limit".
  335.             * This option will only work on registerd versions.
  336.  
  337.          TAB- Toggles editing mode (Flags/Without flags in the editing
  338.               screen).
  339.  
  340.        Alt X- Saves the currect menu,if changes have been made since last
  341.               save , and quits Menu Wizard.
  342.  
  343.        Alt Q- Quits the Menu Wizard.
  344.               CAUTION: this option does NOT save the current menu !
  345.  
  346.          ESC- will get you to the main menu again.
  347.  
  348.  
  349.  
  350.  
  351.                Menu Wizard v1.00 - User Document - Page 8
  352.  
  353.  
  354.  
  355.  Data Replace: This will ask you for a string to find and replace in all
  356.                the data fields, it will also ask if you wish to do this
  357.                process using a "case-sensitive" replacer. If the 'search'
  358.                string was found,Menu Wizard will ask you wheather to replace
  359.                the 'search' string with the 'replace' string.
  360.  
  361.  
  362.  Secu Replace: Asks for a specific security level, and replaces all the
  363.                security levels of the menu with that one. a "Replace (Y/N) ?"
  364.                question will be asked for every command line.
  365.  
  366.  
  367. Flags replace: Same as "SECURITY REPLACE" but for the flag field.
  368.  
  369.  
  370.  QBBS
  371.    Simulation: This will display a full simulation of QUICKBBS using your
  372.                menus. You will be asked to enter a security level,and to
  373.                choose between ANSI and ASCII work-modes.Then, the TOP menu
  374.                will start running, where you will be able to actually play
  375.                with your BBS menus. If a menu was loaded at the time you have
  376.                choosen the simulate option, you will be asked if you want to
  377.                save that menu (if it was not saved).
  378.  
  379.                HOTKEYS are available in the simulation mode, ESC and the
  380.                log off command will stop it at any stage, and will restore
  381.                the menu you have been editing.
  382.  
  383.  
  384.  
  385.                Menu Wizard v1.00 - User Document - Page 9
  386.  
  387.  
  388.  
  389.  Text:
  390.  -----
  391.  
  392.  Edit: Enters you to the internal TEXT editor. The text will be entered into
  393.        the menu file as the "display lines". On your left side, there are
  394.        numbers that looks like a spreadsheet, these lines represent the menu
  395.        entries, and if, for example you edit line "1", the text on it will be
  396.        saved as the "display line" of entry #1 in the current menu.
  397.  
  398.        Near the line numbers, you'll find letters from A to Z, they represent
  399.        security levels, which are taken from the LIMITS.CTL file.
  400.        "A" represents the lowest security level, and so on...
  401.  
  402.        Note that you are in a full screen editor environment.
  403.  
  404.        "^" is used to turn the highlight attribute on/off.
  405.        ";" will make qbbs continue the typing of the next command text on the
  406.            same line,and not from the beginning of the next line.
  407.  
  408.        ALT-C chooses the current line's attribute.
  409.        ALT-H chooses the menu's hightlight attribute.
  410.        ALT-<right-arrow> Increases the line's color number, this way you can
  411.                          play with the line's colors.
  412.        ALT-<left-arrow>  Decreases the line's color number.
  413.        ALT-<PgUp>/<PdDn> Same thing, but for background.
  414.        ALT-F1 thru F6    Chooses a special character set.You can use the set by
  415.                          pressing F1 to F10.
  416.        ALT-S             Simulation of the CURRENT menu only.
  417.        ESC               Returns to main menu.
  418.  
  419.  
  420.  
  421.  
  422.                Menu Wizard v1.00 - User Document - Page 10
  423.  
  424.  
  425.  
  426.  Simulate: Just like ALT-S in the text-edit mode.
  427.  
  428.    Import: Imports a text file into the internal text (erases the current text)
  429.            WARNING- Won't ask you again if you're sure !
  430.  
  431.    Export: Take internal text and puts it to an exterrnal textfile on the
  432.            disk.
  433.  
  434.            In both Import and Export you can choose a color file to
  435.            Import/Export the text to. This file structure is unique to
  436.            Menu Wizard. That file contains not only the text,but all of the
  437.            line's attributes.
  438.  
  439.     Clear: Clears text, to start it all over again.
  440.  
  441.   Editors: Here you have an option to run an ANSI or an ASCII editor,
  442.            if you have a "type 40" command, it will suggest to take the
  443.            filename and put it as a parameter to the external editor for
  444.            automatic load.
  445.  
  446.  
  447.  Prompt
  448.  ------
  449.  
  450.  Prompt line:  Edit the menu's prompt line
  451.        Color:  Edit the menu's prompt attributes
  452.  
  453.  
  454.  Printer
  455.  -------
  456.  
  457.  Menu Dump:  Dumps the menu command lines as shown in the command edit mode
  458.              to printer
  459.  
  460.  Text Dump:  You have options to print 2 things:
  461.              1. the internal text
  462.              2. the external type-40 text (the ascii file). This command will
  463.                 type the ascii file you have designed for that menu,using type
  464.                 40.
  465.  
  466.  
  467.  Set-Up
  468.  ------
  469.  
  470.  Lets you reinstall Menu Wizard. (change qbbs path,the ansi/ascii editor's
  471.  command line the flag mode and the direct screen access).
  472.  
  473.  If you have any problems with the set up file,just erase the file menuwiz.ctl
  474.  and run menu wizard again.
  475.  
  476.  
  477.  
  478.